package com.stark.commons.spring.core.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 日志注解。
 * <ul>
 * <li>只能加在方法上；</li>
 * <li>在业务系统中实现 {@link com.stark.commons.spring.core.support.log.LogService} 接口；</li>
 * <li>在业务系统配置类中增加 {@link org.springframework.context.annotation.EnableAspectJAutoProxy @EnableAspectJAutoProxy} 注解。</li>
 * </ul>
 * @author Ben
 * @since 1.0.0
 * @version 1.0.0
 * @see com.stark.commons.spring.core.aspect.LogAspect
 * @see com.stark.commons.spring.core.support.log.LogService
 * @see com.stark.commons.spring.core.boot.config.LogAopAutoConfig
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Log {
	
	/** 日志类型 */
	int type() default -1;
	
	/** 业务 KEY */
	String businessKey() default "";
	
	/** 消息 */
	String message() default "";
	
	/** 日志记录阶段 */
	Stage stage() default Stage.AFTER;
	
	/**
	 * 枚举日志记录阶段。
	 */
	enum Stage {
		/**
		 * 方法执行前
		 */
		BEFORE,
		/**
		 * 方法执行后
		 */
		AFTER;
	}

}
